Confirmation of Funds APIs

4.0.x
(0 reviews)

Confirmation of Funds Examples

This section provides examples of API invocation to confirm availability of funds information.

1. POST – Funds Confirmation Consent

This API can be used by CBPII to post the consent request for the pre-selected customer account.

Post request: Funds Confirmation Consent

POST /funds-confirmation-consents HTTP/1.1
Content-Type: application/json
Authorization: Bearer 1t1satruthun1v3rs4lly
Accept: application/json; charset=utf-8
x-fapi-auth-date: Mon, 13 Nov 2017 19:49:37 GMT
x-fapi-customer-ip-address: 92.11.92.11
x-fapi-interaction-id: hook5i13-ntIg-4th3-rP41-3ro535touch3

{
  "Data": {
    "DebtorAccount": {
      "SchemeName": "UK.OBIE.SortCodeAccountNumber",
      "Identification": "GB76LOYD30949301273801",
      "Name": "Test",
      "SecondaryIdentification": "Roll 56988"
    },
    "ExpirationDateTime": "2017-05-02T00:00:00+00:00"
  }
}

Post response: Funds Confirmation Consent

HTTP/1.1 201 Created
Content-Type: application/json
x-fapi-interaction-id: hook5i13-ntIg-4th3-rP41-3ro535touch3

{
  "Data": {
    "ConsentId": "88379",
    "CreationDateTime": "2017-05-02T00:00:00+00:00",
    "Status": "AwaitingAuthorisation",
    "StatusUpdateDateTime": "2017-05-02T00:00:00+00:00",
    "ExpirationDateTime": "2017-05-02T00:00:00+00:00",
    "DebtorAccount": {
      "SchemeName": "UK.OBIE.SortCodeAccountNumber",
      "Identification": "GB76LOYD30949301273801",
      "Name": "Test",
      "SecondaryIdentification": "Roll 56988"
    }
  },
  "Links": {
    "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/funds-confirmation-consents/88379"
  }
}

This API allows a CBPII to get the status of the consent request for the pre-selected customer account.

GET request: Funds Confirmation Consent

GET /funds-confirmation-consents/88379 HTTP/1.1

Authorization: Bearer Jhingapulaav
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

GET response: Funds Confirmation Consent

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
  "Data": {
    "ConsentId": "88379",
    "CreationDateTime": "2017-05-02T00:00:00+00:00",
    "Status": "AwaitingAuthorisation",
    "StatusUpdateDateTime": "2017-05-02T00:00:00+00:00",
    "ExpirationDateTime": "2017-05-02T00:00:00+00:00",
    "DebtorAccount": {
      "SchemeName": "UK.OBIE.SortCodeAccountNumber",
      "Identification": "GB76LOYD30949301273801",
       "Name": "Test",
      "SecondaryIdentification": "Roll 56988"
    }
  },
  "Links": {
    "Self":  "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/funds-confirmation-consents/88379"

  }
}
3. Funds Confirmation

This API allows a CBPII to confirm availability of funds on a customer consented account.

Post request: Funds Confirmation

POST /funds-confirmations HTTP/1.1
Content-Type: application/json
Authorization: Bearer 1t1satruthun1v3rs4lly
Accept: application/json; charset=utf-8
x-fapi-interaction-id: hook5i13-ntIg-4th3-rP41-3ro535touch3

{
  "Data": {
    "ConsentId": "88379",
    "Reference": "Purchase01",
    "InstructedAmount": {
       "Amount": "20.00",
       "Currency": "GBP"
    }
  }
}

Post response: Funds Confirmation

HTTP/1.1 201 Created
Content-Type: application/json
x-fapi-interaction-id: hook5i13-ntIg-4th3-rP41-3ro535touch3

{
  "Data": {
    "FundsConfirmationId": "123456",
    "ConsentId": "88379",
    "CreationDateTime": "2017-05-02T00:00:00+00:00",
    "FundsAvailable": true,
    "Reference": "Purchase01",
    "InstructedAmount": {
       "Amount": "20.00",
       "Currency": "GBP"
    }
  },
  "Links": {
    "Self": " https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/funds-confirmations/123456"
  }
}

This API can be used to revoke the consent for confirmation of funds.

DELETE request: Funds Confirmation Consent

DELETE /funds-confirmation-consents/88379 HTTP/1.1
Authorization: Bearer Jhingapulaav
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d

DELETE response: Funds Confirmation Consent

HTTP/1.1 204 No Content
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Versioning

This API specification conforms to the Open Banking UK Confirmation of Funds API Specification – v3.1.8

Reviews